home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Applications 1996 May / SGI IRIX 6.2 Applications 1996 May.iso / dist / impr_dev.idb / usr / impressario / bin / examples / libpod / README.z / README
Text File  |  1996-05-06  |  4KB  |  107 lines
  1.  
  2.  
  3.                 Example Programs
  4.                      for
  5.                     libpod
  6.  
  7.  
  8. These example programs demonstrate the use of the libpod API. Each
  9. program is designed to demonstrate a particular aspect of the API.
  10. The programs also perform error handling using the library's error
  11. handling facilities. Most programs are useful printer status tools in their
  12. own right but a few are simply demonstrations not meant to perform any
  13. particular task. Refer to the libpod(3) man pages for detailed
  14. information on the libpod API.
  15.  
  16. Note that there are often two versions of the same program. One version,
  17. prefixed with an 'l', uses the Local form of the libpod functions.
  18. The other version of the program, without an 'l', uses the standard form
  19. of the libpod functions. Refer to the libpod(3) man page for information
  20. about the Local and Standard functions.
  21.  
  22.  
  23. info - Usage: info printer_name
  24.  
  25.     Demonstrates the use of the standard form of the libpod info
  26.     read function.
  27.  
  28.  
  29. linfo - Usage: linfo printer_name [printer_opt_string]
  30.  
  31.     Demonstrates the use of the local form of the libpod info
  32.     read and write functions. If printer_opt_string is specified,
  33.     it is expected to be a quoted string describing any optional
  34.     equipment the the specified printer may contain. An empty
  35.     string indicates no optional equipment. An attempt is made to
  36.     write the optional equipment information into the specified
  37.     printer's configuration file. If printer_opt_string is not
  38.     specified, the current configuration and status information
  39.     is displayed.
  40.  
  41.     Note: You must have root or lp permissions to successfully run
  42.           this program to write the config file. There is no such
  43.           restriction on reading the config or status files.
  44.  
  45.  
  46. logit - Usage: logit [-j job_id] [-u username] printer_name
  47.              start|end|{msg_code}
  48.  
  49.     Demonstrates the use of the local libpod log file write function.
  50.     The message parameter specified on the command-line determines
  51.     the standard message that will be written to the log file.
  52.  
  53.     start - prints a standard print job start message in the log file
  54.     end - prints a standard print job end message in the log file
  55.     msg_code - any valid message code number. Code numbers can be
  56.             specified in decimal, hex or octal.
  57.  
  58.     Note: you must have root or lp permission to successfully run this
  59.           program.
  60.  
  61.  
  62. lstatus - Usage: lstatus printer_name [op_status]
  63.  
  64.     Demonstrates the use of the local form of the libpod status read
  65.     and write functions. If op_status is specified, an attempt is made
  66.     to write the new operational status to the printer POD status file.
  67.     The status before and after the write are displayed. If op_status
  68.     is not specified, the current status is displayed.
  69.  
  70.     Note: You must have root or lp permissions to successfully run
  71.           this program to write the status file. There is no such
  72.           restriction on reading the status file.
  73.  
  74.  
  75. message - Usage: message
  76.  
  77.     Demonstrates how to use the PDMakeMessage function. The program
  78.     does not perform any useful work as far as interacting with POD
  79.     files.
  80.  
  81.  
  82. pagesize - Usage: pagesize printer_name [page_size_name]
  83.  
  84.     Demonstrates the use of the page size search function and
  85.     other page size convenience functions. The program obtains
  86.     the printer information structure using the standard info read
  87.     function. If a page size name has not been specified on the
  88.     command line the size information for the currently loaded
  89.     media is displayed. If a page size name has been specified,
  90.     the size information for that media is displayed if the
  91.     specified printer supports that page size.
  92.  
  93.  
  94. readlog - Usage: readlog printer_name [num_lines]
  95.  
  96.     Demonstrates the use of the standard form of the libpod log file
  97.     read function. If num_lines is not specified, the entire log file
  98.     will be read and display on standard out. If num_lines is specified,
  99.     the last num_lines lines of the log file will be read and displayed.
  100.  
  101.  
  102. status - Usage: status printer_name
  103.  
  104.     Demonstrates the use of the standard form of the libpod status
  105.     read functions.
  106.  
  107.